The CxArsEditor object contains the following methods:
The Connect method connects to a ARS.
Connect(DomainSiteService As String)
| Parameter | Required | Description |
|---|---|---|
|
DomainSiteService |
Yes |
The [Domain]Site.Service to which to connect. A domain is optional. The service must be a valid ARS. |
Example
The following example creates and connects the CxArsEditor object.
|
Sub Dim ArsEditor Set ArsEditor = CreateObject("CxEditors.CxArsEditor") ArsEditor.Connect("[5410]CYGDEMO.ARS") End Sub |
The Delete method prompts the usr to delete an ARS entry.
Delete(QueueKey As String) As Integer
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The Site.Service to delete. |
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example prompts the user to delete CYGDEMO.OPCIS from the ARS.
|
Sub Dim iRet iRet = ArsEditor.Delete("CYGDEMO.OPCIS")
MsgBox iRet End Sub |
The Disconnect method disconnects from the connected ARS.
Disconnect()
Example
The following example disconnects the ArsEditor object.
|
Sub ArsEditor.Disconnect End Sub |
The Edit method launches an ARS property sheet for the specified entry.
Edit(SiteService As String) As Integer
| Parameter | Required | Description |
|---|---|---|
|
SiteService |
Yes |
The Site.Service to edit. |
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches a property sheet for the CYGDEMO.OPCIS entry.
|
Sub Dim iRet iRet = ArsEditor.Edit("CYGDEMO.OPCIS")
MsgBox iRet End Sub |
The New method launches a New Service dialog box for creating a new ARS entry.
New() As Integer
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches a New Service dialog box.
|
Sub Dim iRet iRet = ArsEditor.New
MsgBox iRet End Sub |
|
|
|
